home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2002 #11 / Amiga Plus CD - 2002 - No. 11.iso / Tools / Freeware / Htmldoc / man / man1 / htmldoc.1
Text File  |  2002-10-28  |  15KB  |  515 lines
  1. htmldoc(1)            Easy Software Products           htmldoc(1)
  2.  
  3.  
  4.  
  5. NNAAMMEE
  6.        htmldoc - convert html source files into html, postscript,
  7.        or pdf.
  8.  
  9.  
  10. SSYYNNOOPPSSIISS
  11.        htmldoc [options] filename1.html [ ... filenameN.html ]
  12.  
  13.        htmldoc [options] -
  14.  
  15.        htmldoc [filename.book]
  16.  
  17.  
  18. DDEESSCCRRIIPPTTIIOONN
  19.        _H_T_M_L_D_O_C converts HTML  source  files  into  indexed  HTML,
  20.        PostScript,  or  Portable Document Format (PDF) files that
  21.        can be viewed online or printed.  With no  options  a  PDF
  22.        document is produced on stdout.
  23.  
  24.        The  second  form of _H_T_M_L_D_O_C reads HTML source from stdin,
  25.        which allows you to use _H_T_M_L_D_O_C as a filter.
  26.  
  27.        The third form of _H_T_M_L_D_O_C launches a  graphical  interface
  28.        that  allows  you to change options and generate documents
  29.        interactively.
  30.  
  31. CCOOMMMMOONN MMIISSTTAAKKEESS
  32.        There are two types of HTML files -  structured  documents
  33.        using headings (H1, H2, etc.) which _H_T_M_L_D_O_C calls "books",
  34.        and unstructured documents that do not use headings  which
  35.        _H_T_M_L_D_O_C calls "web pages".
  36.  
  37.        A  very  common  mistake  is  to try converting a web page
  38.        using:
  39.  
  40.        htmldoc -f filename.pdf filename.html
  41.  
  42.        which will likely produce a PDF file  with  no  pages.  To
  43.        convert  web  page  files  you  mmuusstt  use the _-_-_w_e_b_p_a_g_e or
  44.        _-_-_c_o_n_t_i_n_u_o_u_s options at the  command-line  or  choose  _W_e_b
  45.        _P_a_g_e or _C_o_n_t_i_n_u_o_u_s in the input tab of the GUI.
  46.  
  47. OOPPTTIIOONNSS
  48.        The  following command-line options are supported by _H_T_M_L_-
  49.        _D_O_C:
  50.  
  51.  
  52.        --batch _f_i_l_e_n_a_m_e_._b_o_o_k
  53.             Generates the specified book file without opening the
  54.             GUI.
  55.  
  56.  
  57.        --bodycolor _c_o_l_o_r
  58.             Specifies the background color for all pages.
  59.  
  60.  
  61.        --bodyfont _{_c_o_u_r_i_e_r_,_t_i_m_e_s_,_h_e_l_v_e_t_i_c_a_}
  62.  
  63.        --textfont _{_c_o_u_r_i_e_r_,_t_i_m_e_s_,_h_e_l_v_e_t_i_c_a_}
  64.             Specifies the default typeface for all normal text.
  65.  
  66.  
  67.        --bodyimage _f_i_l_e_n_a_m_e
  68.             Specifies  the  background image that is tiled on all
  69.             pages.
  70.  
  71.  
  72.        --book
  73.             Specifies that the HTML sources are structured (head-
  74.             ings, chapters, etc.)
  75.  
  76.  
  77.        --bottom _m_a_r_g_i_n
  78.             Specifies  the  bottom margin in points (no suffix or
  79.             ##pt), inches (##in), centimeters (##cm), or millime-
  80.             ters (##mm).
  81.  
  82.  
  83.        --charset _{_8_8_5_9_-_1_._._._8_8_5_9_-_1_5_}
  84.             Specifies  the  ISO character set to use for the out-
  85.             put.
  86.  
  87.  
  88.        --color
  89.             Specifies that PostScript or PDF output should be  in
  90.             color.
  91.  
  92.  
  93.        --continuous
  94.             Specifies  that  the  HTML  sources  are unstructured
  95.             (plain web  pages.)   No  page  breaks  are  inserted
  96.             between each file or URL in the output.
  97.  
  98.  
  99.        --datadir _d_i_r_e_c_t_o_r_y
  100.             Specifies  the  location  of  the _H_T_M_L_D_O_C data files,
  101.             usually _/_u_s_r_/_s_h_a_r_e_/_h_t_m_l_d_o_c or _C_:_\_P_r_o_g_r_a_m  _F_i_l_e_s_\_H_T_M_L_-
  102.             _D_O_C.
  103.  
  104.  
  105.        --duplex
  106.             Specifies  that  the  output  should be formatted for
  107.             double-sided printing.
  108.  
  109.  
  110.        --effectduration _{ _0_._1_._._1_0_._0 _}
  111.             Specifies the duration in seconds of PDF page transi-
  112.             tion effects.
  113.  
  114.  
  115.        --embedfonts
  116.             Specifies  that  fonts  should be embedded in PDF and
  117.             PostScript output.
  118.  
  119.  
  120.        --encryption
  121.             Enables encryption of PDF files.
  122.  
  123.  
  124.        --fontsize _s_i_z_e
  125.             Specifies the default font size for body text.
  126.  
  127.  
  128.        --fontspacing _s_p_a_c_i_n_g
  129.             Specifies the default line spacing for body text. The
  130.             line  spacing is a multiplier for the font size, so a
  131.             value of 1.2 will provide an additional 20% of  space
  132.             between the lines.
  133.  
  134.  
  135.        --footer _f_f_f
  136.             Sets  the  page  footer to use on body pages. See the
  137.             _H_E_A_D_E_R_S_/_F_O_O_T_E_R_S _F_O_R_M_A_T_S section below.
  138.  
  139.  
  140.        --format _f_o_r_m_a_t
  141.  
  142.        -t _f_o_r_m_a_t
  143.             Specifies  the  output  format:  html,  ps   or   ps2
  144.             (PostScript  Level  2), ps1 (PostScript Level 1), ps3
  145.             (PostScript Level 3), pdf11  (PDF  1.1/Acrobat  2.0),
  146.             pdf12  (PDF  1.2/Acrobat  3.0),  pdf  or  pdf13  (PDF
  147.             1.3/Acrobat 4.0), or pdf14 (PDF 1.4/Acrobat 5.0).
  148.  
  149.  
  150.        --gray
  151.             Specifies that PostScript or  PDF  output  should  be
  152.             grayscale.
  153.  
  154.  
  155.        --header _f_f_f
  156.             Sets  the  page  header to use on body pages. See the
  157.             _H_E_A_D_E_R_S_/_F_O_O_T_E_R_S _F_O_R_M_A_T_S section below.
  158.  
  159.  
  160.        --headfootfont _f_o_n_t
  161.             Sets the font to use on headers and footers.
  162.  
  163.  
  164.        --headfootsize _s_i_z_e
  165.             Sets the size of the font to use on headers and foot-
  166.             ers.
  167.  
  168.  
  169.        --headingfont _t_y_p_e_f_a_c_e
  170.             Sets the typeface to use for headings.
  171.  
  172.  
  173.        --help
  174.             Displays a summary of command-line options.
  175.  
  176.  
  177.        --helpdir _d_i_r_e_c_t_o_r_y
  178.             Specifies  the  location  of the _H_T_M_L_D_O_C on-line help
  179.             files, usually _/_u_s_r_/_s_h_a_r_e_/_d_o_c_/_h_t_m_l_d_o_c  or  _C_:_\_P_r_o_g_r_a_m
  180.             _F_i_l_e_s_\_H_T_M_L_D_O_C_\_D_O_C.
  181.  
  182.  
  183.        --jpeg_[_=_q_u_a_l_i_t_y_]
  184.             Sets  the  JPEG  compression  level  to use for large
  185.             images. A value of 0 disables JPEG compression.
  186.  
  187.  
  188.        --left _m_a_r_g_i_n
  189.             Specifies the left margin in  points  (no  suffix  or
  190.             ##pt), inches (##in), centimeters (##cm), or millime-
  191.             ters (##mm).
  192.  
  193.  
  194.        --linkcolor _c_o_l_o_r
  195.             Sets the color of links.
  196.  
  197.  
  198.        --links
  199.             Enables generation of links in PDF files (default).
  200.  
  201.  
  202.        --linkstyle _{_p_l_a_i_n_,_u_n_d_e_r_l_i_n_e_}
  203.             Sets the style of links.
  204.  
  205.  
  206.        --logoimage _f_i_l_e_n_a_m_e
  207.             Specifies an image to be used as a logo in the header
  208.             or footer in a PostScript or PDF document, and in the
  209.             navigation bar of a HTML document.
  210.  
  211.  
  212.        --no-compression
  213.             Disables compression of PostScript or PDF files.
  214.  
  215.  
  216.        --no-duplex
  217.             Disables double-sided printing.
  218.  
  219.  
  220.        --no-embedfonts
  221.             Specifies that fonts should not be  embedded  in  PDF
  222.             and PostScript output.
  223.  
  224.  
  225.        --no-encryption
  226.             Disables document encryption.
  227.  
  228.  
  229.        --no-jpeg
  230.             Disables JPEG compression of large images.
  231.  
  232.  
  233.        --no-links
  234.             Disables generation of links in a PDF document.
  235.  
  236.  
  237.        --no-numbered
  238.             Disables automatic heading numbering.
  239.  
  240.  
  241.        --no-pscommands
  242.             Disables  generation of PostScript setpagedevice com-
  243.             mands.
  244.  
  245.  
  246.        --no-strict
  247.             Disables strict HTML input checking.
  248.  
  249.  
  250.        --no-title
  251.             Disables generation of a title page.
  252.  
  253.  
  254.        --no-toc
  255.             Disables generation of a table of contents.
  256.  
  257.  
  258.        --numbered
  259.             Numbers all headings in a document.
  260.  
  261.  
  262.        --nup _p_a_g_e_s
  263.             Sets the number of pages that are placed on each out-
  264.             put page.  Valid values are 1, 2, 4, 6, 9, and 16.
  265.  
  266.  
  267.        --outdir _d_i_r_e_c_t_o_r_y
  268.  
  269.        -d _d_i_r_e_c_t_o_r_y
  270.             Specifies  that  output should be sent to a directory
  271.             in multiple files.  (Not compatible with PDF output)
  272.  
  273.  
  274.        --outfile _f_i_l_e_n_a_m_e
  275.  
  276.        -f _f_i_l_e_n_a_m_e
  277.             Specifies that output should  be  sent  to  a  single
  278.             file.
  279.  
  280.  
  281.        --owner-password _p_a_s_s_w_o_r_d
  282.             Sets the owner password for encrypted PDF files.
  283.  
  284.  
  285.        --pageduration _{_1_._0_._._6_0_._0_}
  286.             Sets the view duration of a page in a PDF document.
  287.  
  288.  
  289.        --pageeffect _e_f_f_e_c_t
  290.             Specifies  the  page transition effect for all pages;
  291.             this attribute is ignored by all Adobe PDF viewers...
  292.  
  293.  
  294.        --pagelayout _{_s_i_n_g_l_e_,_o_n_e_,_t_w_o_l_e_f_t_,_t_w_o_r_i_g_h_t_}
  295.             Specifies the initial layout of pages for a PDF file.
  296.  
  297.  
  298.        --pagemode _{_d_o_c_u_m_e_n_t_,_o_u_t_l_i_n_e_s_,_f_u_l_l_s_c_r_e_e_n_}
  299.             Specifies the initial viewing mode for a PDF file.
  300.  
  301.  
  302.        --path
  303.             Specifies a search path for files in a document.
  304.  
  305.  
  306.        --permissions _p_e_r_m_i_s_s_i_o_n
  307.             Specifies  document  permissions  for  encrypted  PDF
  308.             files. Multiple _-_-_p_e_r_m_i_s_s_i_o_n_s options are required to
  309.             grant or deny  specific  permissions.  The  following
  310.             values  are understood: all, none, annotate, no-anno-
  311.             tate, copy, no-copy, modify,  no-modify,  print,  and
  312.             no-print.
  313.  
  314.  
  315.        --pscommands
  316.             Specifies   that  PostScript  setpagedevice  commands
  317.             should be included in the output.
  318.  
  319.  
  320.        --quiet
  321.             Suppresses all messages, even error messages.
  322.  
  323.  
  324.        --right _m_a_r_g_i_n
  325.             Specifies the right margin in points  (no  suffix  or
  326.             ##pt), inches (##in), centimeters (##cm), or millime-
  327.             ters (##mm).
  328.  
  329.  
  330.        --size _p_a_g_e_s_i_z_e
  331.             Specifies the page size using a standard name  or  in
  332.             points (no suffix or ##x##pt), inches (##x##in), cen-
  333.             timeters (##x##cm),  or  millimeters  (##x##mm).  The
  334.             standard  sizes  that  are  currently  recognized are
  335.             "letter"   (8.5x11in),   "legal"   (8.5x14in),   "a4"
  336.             (210x297mm), and "universal" (8.27x11in).
  337.  
  338.  
  339.        --strict
  340.             Enables strict HTML input checking.
  341.  
  342.  
  343.        --textcolor _c_o_l_o_r
  344.             Specifies the default color of all text.
  345.  
  346.  
  347.        --title
  348.             Enables the generation of a title page.
  349.  
  350.  
  351.        --titlefile _f_i_l_e_n_a_m_e
  352.  
  353.        --titleimage _f_i_l_e_n_a_m_e
  354.             Specifies  the file to use for the title page. If the
  355.             file is an image then the title page is automatically
  356.             generated  using  the  document  meta  data and title
  357.             image.
  358.  
  359.  
  360.        --tocfooter _f_f_f
  361.             Sets the page  footer  to  use  on  table-of-contents
  362.             pages. See the _H_E_A_D_E_R_S_/_F_O_O_T_E_R_S _F_O_R_M_A_T_S section below.
  363.  
  364.  
  365.        --tocheader _f_f_f
  366.             Sets the page  header  to  use  on  table-of-contents
  367.             pages. See the _H_E_A_D_E_R_S_/_F_O_O_T_E_R_S _F_O_R_M_A_T_S section below.
  368.  
  369.  
  370.        --toclevels _l_e_v_e_l_s
  371.             Sets the number of levels in the table-of-contents.
  372.  
  373.  
  374.        --toctitle _s_t_r_i_n_g
  375.             Sets the title for the table-of-contents.
  376.  
  377.  
  378.        --top _m_a_r_g_i_n
  379.             Specifies the top margin  in  points  (no  suffix  or
  380.             ##pt), inches (##in), centimeters (##cm), or millime-
  381.             ters (##mm).
  382.  
  383.  
  384.        --user-password _p_a_s_s_w_o_r_d
  385.             Specifies the user password  for  encryption  of  PDF
  386.             files.
  387.  
  388.  
  389.        --verbose
  390.  
  391.        -v
  392.             Provides verbose messages.
  393.  
  394.  
  395.        --version
  396.             Displays the current version number.
  397.  
  398.  
  399.        --webpage
  400.             Specifies  that  the  HTML  sources  are unstructured
  401.             (plain web pages.)  A page break is inserted  between
  402.             each file or URL in the output.
  403.  
  404.  
  405. HHEEAADDEERR//FFOOOOTTEERR FFOORRMMAATTSS
  406.        The header and footer of each page can contain up to three
  407.        preformatted values. These values are  specified  using  a
  408.        single  character  for  the left, middle, and right of the
  409.        page, resulting in the _f_f_f notation shown previously.
  410.  
  411.        Each character can be one of the following:
  412.  
  413.  
  414.        blank
  415.  
  416.  
  417.        /
  418.             n/N arabic page numbers (1/3, 2/3, 3/3)
  419.  
  420.  
  421.        :
  422.             c/C arabic chapter page numbers (1/2, 2/2, 1/4,  2/4,
  423.             ...)
  424.  
  425.  
  426.        1
  427.             arabic numbers (1, 2, 3, ...)
  428.  
  429.  
  430.        a
  431.             lowercase letters
  432.  
  433.  
  434.        A
  435.             uppercase letters
  436.  
  437.  
  438.        c
  439.             current chapter heading
  440.  
  441.  
  442.        C
  443.             current chapter page number (arabic)
  444.  
  445.  
  446.        d
  447.             current date
  448.  
  449.  
  450.        D
  451.             current date and time
  452.  
  453.  
  454.        h
  455.             current heading
  456.  
  457.  
  458.        i
  459.             lowercase roman numerals
  460.  
  461.  
  462.        I
  463.             uppercase roman numerals
  464.  
  465.  
  466.        l
  467.             logo image
  468.  
  469.  
  470.        t
  471.             title text
  472.  
  473.  
  474.        T
  475.             current time
  476.  
  477.  
  478. SSEEEE AALLSSOO
  479.        HTMLDOC Software Users Manual
  480.  
  481.        http://www.easysw.com/htmldoc
  482.  
  483. AAUUTTHHOORR
  484.        Michael Sweet (mike@easysw.com), Easy Software Products
  485.  
  486. TTRRAADDEEMMAARRKKSS
  487.        PostScript  is  a trademark that may be registered in some
  488.        countries and Adobe is a  registered  trademark  of  Adobe
  489.        Systems Incorporated.
  490.  
  491. CCOOPPYYRRIIGGHHTTSS
  492.        Portable Document Format Copyright 1993-1999 by Adobe Sys-
  493.        tems Incorporated.
  494.  
  495.        HTMLDOC is copyright 1997-2002 by Easy Software  Products.
  496.        This  program  is  free  software; you can redistribute it
  497.        and/or modify it under the terms of the GNU General Public
  498.        License  as  published  by  the  Free Software Foundation;
  499.        either version 2 of the License, or (at your  option)  any
  500.        later version.
  501.  
  502.        This  program is based in part on the work of the Indepen-
  503.        dent JPEG Group.
  504.  
  505. NNOO WWAARRRRAANNTTYY
  506.        This program is distributed in the hope that  it  will  be
  507.        useful, but WITHOUT ANY WARRANTY; without even the implied
  508.        warranty of MERCHANTABILITY or FITNESS  FOR  A  PARTICULAR
  509.        PURPOSE.   See  the  GNU  General  Public License for more
  510.        details.
  511.  
  512.  
  513.  
  514. 8 August 2002             HTMLDOC 1.8.21               htmldoc(1)
  515.